logo头像
Snippet 博客主题

辅助工具 接口文档管理工具

本文于377天之前发表,文中内容可能已经过时。

每个公司有自己接口管理
有自己的 接口管理网页(html页面 ajax测试)
有自己公司的GUI工具 (测试接口 )
Postman 测试的

下面介绍下 第三方的接口管理

1 RAP 阿里巴巴

http://rap.taobao.org/org/index.do
http://rapapi.org/org/index.do

最初接触 是学习慕课网 js全栈 视频 介绍的 作者之前维护这个项目
可视化接口管理工具
设定接口
模拟数据
校验真实接口正确性

2 doclever

http://doclever.cn/
全部开源 太牛了

围绕接口定义文档,通过一系列自动化工具提升我们的协作效率。
DOClever前后端全部采用了javascript来作为开发语言,
前端用的是vue+element UI
后端是express+mongodb,

正在使用中 体验完 在写 感受

3 Swagger

Swagger是一个规范和完整的框架,
用于生成、描述、调用和可视化RESTful风格的Web服务。

简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言的前后端分离解决方案。
Swagger主要包含了以下4个部分:
  1. Swagger可以直接嵌入项目中,通过开发时编写注释,自动生成接口文档;
  2. Swagger包含了SwaggerEditor,它是使用yaml语言的Swagger API的编辑器,支持导出yaml和json格式的接口文件;
  3. Swagger包含了SwaggerUI,它将Swagger Editor编辑好的接口文档以html的形式展示出来;
  4. Swagger支持根据定义的接口导出各种语言的服务端或客户端代码。
  
  其中1和4是更加面向开发的内容,开发团队要有自动生成文档的需求,在开发和自测中遵循前后端分离。而2和3是相对可以独立出来的、可供QA人员参考的接口文档管理方案,也是我们主要关注的部分。

  Swagger提供了SwaggerEditor和Swagger UI的在线demo,如下图。可以看出,Swagger可以完整地定义一个接口的内容,包括各个参数、返回值的具体结构、类型,SwaggerEditor可以实时进行编辑并在线调试。编辑好的API可以导出为json文件,使用Swagger UI打开即可以看到更美观的接口文档。

  Swagger Editor和SwaggerUI的本地部署十分简单,这两者都可以直接从Github上下载源码,将其部署到本地Tomcat服务器上,然后通过浏览器访问即可。官方还提供了其他几种部署方式,具体步骤在帮助文档中有详细说明,这里不再赘述。

这个 还没使用过 待更新

支付宝打赏 微信打赏

打赏